FlowDocument Methods
An object defining methods for the FlowDocument class.
SetExistingDocumentByPathAsync(existingDocumentPath)
shortDescription
Replaces the current document with an existing file from Document Management (DM), even if the current document type is fixed or existing, and sets the new document as an existing document.
param(existingDocumentPath): string, required
The path of the file in Document Management to be used as the new document.
return: Task
This is a async method. Method should be waited. Be careful if call this method without waiting.
See Also
SetControlText(controlName, text)
Sets the text of a specified control in the document.
Parameters:
controlName (required): string
The name of the control to set the text for.
text (required): string
The text to assign to the control.
This is a sync method. Method runs synchronously.
Initialize()
Initializes the document and prepares it for further operations.
Returns:
Type: void
Method does not return anything
This is a sync method. Method runs synchronously.
SetControlValue(controlName, value)
Sets the value of a specified control in the document.
Parameters:
controlName (required): string
The name of the control to set the value for.
value (required): object
The value to assign to the control.
Returns:
Type: void
Method does not return anything
This is a sync method. Method runs synchronously.
GetControlValue(controlName)
Retrieves the value of a specified control from the document.
Parameters:
controlName (required): string
The name of the control to retrieve the value from.
Returns:
Type: FormGetControlValueResponse
A response containing the control value and related metadata.
This is a sync method. Method runs synchronously.